Skip to content

fix: update installation guides and sidebar paths#2613

Merged
vinckr merged 11 commits into
masterfrom
fix/setup-guides-across-deployment-models
Jun 23, 2026
Merged

fix: update installation guides and sidebar paths#2613
vinckr merged 11 commits into
masterfrom
fix/setup-guides-across-deployment-models

Conversation

@wassimoo

@wassimoo wassimoo commented Jun 8, 2026 •
edited by coderabbitai Bot
Loading

Copy link
Copy Markdown
Contributor

Ory Network - identities/get-started/setup

  • Replaced inline macOS brew snippet with the reusable component
  • Added missing Linux and Windows CLI install tabs using and components
  • Fixed tunnel command syntax: ory tunnel --project $ORY_PROJECT_ID --port 4000 http://localhost:3000

Shared: _common/install.mdx

  • Replaced separate OS sections (Linux, macOS, Windows, Docker, Kubernetes) with a single tabbed block
  • Fixed undefined help in macOS tab by defaulting command to repo when not passed

OEL / OSS - kratos/install

  • Updated sidebar paths and shell files for Kratos to prevent routing users to the wrong deployment.

Checklist

  • I have read the contributing guidelines and signed the CLA.
  • I have referenced an issue containing the design document if my change introduces a new feature.
  • I have read the security policy.
  • I confirm that this pull request does not address a security vulnerability.
    If this pull request addresses a security vulnerability,
    I confirm that I got approval (please contact security@ory.com) from the maintainers to push the changes.
  • I have added tests that prove my fix is effective or that my feature works.
  • I have added the necessary documentation within the code base (if appropriate).

Summary by CodeRabbit

  • Documentation
    • Updated the documentation sidebars so Kratos and Keto “install” and related upgrade pages point to the new Open Source locations.
    • Removed legacy changelog items from the Open Source sidebar to streamline navigation from install/upgrade to the next steps.
    • Updated documentation guidance to require adding a URL redirect before deleting a doc page.
  • Chores
    • Added permanent redirects for old Kratos/Keto URLs to preserve access to the correct new destinations.

@coderabbitai

coderabbitai Bot commented Jun 8, 2026 •
edited
Loading

Copy link
Copy Markdown

Review Change Stack

Warning

Review limit reached

@wassimoo, we couldn't start this review because you've reached your PR review rate limit.

More reviews will be available in 3 minutes and 6 seconds. Learn how PR review limits work.

Your organization has used up its prepaid credits, and credit purchases are no longer available. Enable the review add-on in the billing tab to keep reviews running — you're only billed for reviews past your plan's rate limits ($0.25/file).

⌛ How to resolve this issue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based credits.

🚦 How do rate limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan refill rate.

For paid Pro and Pro+ PR reviews, CodeRabbit uses rolling per-developer review limits. Reviews become available again as older review attempts age out of the rolling limit window.

Please see our Fair Usage Limits Policy for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: 00cdf252-2e50-44d5-9617-27df40657e9d

📥 Commits

Reviewing files that changed from the base of the PR and between 739d779 and 38819a9.

📒 Files selected for processing (1)
  • vercel.json
📝 Walkthrough

Walkthrough

The PR updates sidebar navigation across OEL and OSS documentation editions, consolidates Kratos and Keto installation paths, removes legacy changelog entries from five product sidebars, establishes a contributor policy requiring Vercel redirects before page deletion, and implements permanent URL redirects for the affected paths.

Changes

Documentation Structure and Redirect Policy Update

Layer / File(s) Summary
Contributor redirect policy
AGENTS.md		 Added explicit guidance requiring a Vercel redirect before deleting any documentation page.
OEL sidebar path consolidation
sidebars-oel.ts		 Updated Ory Enterprise License sidebar entries: Kratos install and upgrade guides now reference oel/kratos/ paths; Keto install and upgrade guides now reference oel/keto/ paths.
OSS sidebar path consolidation and cleanup
sidebars-oss.ts		 Updated Ory Open Source sidebar entries: Kratos and Keto install and upgrade guides now reference oss/kratos/ and oss/keto/ paths. Removed legacy self-hosted/oel/*/changelog entries from Kratos, Keto, Hydra, Polis, and Oathkeeper sections.
URL redirect implementation
vercel.json		 Added permanent Vercel redirects: /docs/kratos/install and /docs/keto/install to /docs/oel/.../install; /docs/kratos/guides/upgrade, /docs/keto/guides/upgrade, and /docs/keto/quickstart to /docs/oss/... destinations.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Possibly related PRs

  • ory/docs#2522: Introduced AGENTS.md with initial contributor guidance; this PR extends it with an explicit rule about deletion redirects.

Suggested reviewers

  • unatasha8
  • vinckr
  • zepatrik

Poem

🐰 I hopped through sidebars, nudged old paths away,
Built redirects so lost links find home to stay.
A rule now guards each page before it goes,
Safe navigation blooms wherever it flows. ✨

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Description check ❓ Inconclusive The description covers the key changes across multiple areas and includes checklist confirmations, though it lacks explicit issue/design document references as required by the template. Add a reference to the related issue using the format #1234 or explain that this is a documentation improvement that does not require a design document reference.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately describes the main changes in the PR: updating installation guides and sidebar configuration paths for documentation routing.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch fix/setup-guides-across-deployment-models

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

unatasha8
unatasha8 reviewed Jun 11, 2026
View reviewed changes

@unatasha8 unatasha8 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please see https://app.notion.com/p/Updating-Ory-Documentation-Post-Redesign-34afadbbf3c980b699d2e736b952a324 for "How to Update Content (Migrated Sections)".

unatasha8
unatasha8 reviewed Jun 17, 2026
View reviewed changes
Comment thread vercel.json Outdated
Comment thread vercel.json Outdated
Comment thread docs/oss/keto/install.mdx Outdated
Comment thread docs/oel/keto/install.mdx Outdated
Comment thread src/components/Shared/install-oss.mdx
@wassimoo wassimoo changed the title fix: update installation guides and sidebar paths for kratos fix: update installation guides and sidebar paths Jun 18, 2026
vinckr
vinckr approved these changes Jun 23, 2026
View reviewed changes

@vinckr vinckr left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks good to me, great improvement!

couple things for a followup PR maybe:

from my own testing right now

  • ory kratos - all left sidebar items in OEL section remain OEL - great! ✅ (except the ones in guides/reference)
  • ory hydra - when I click installation on OEL section in hydra, I end up at https://docs-flc5ru6gs-ory.vercel.app/docs/hydra/self-hosted/install which is in OSS section 🚧
  • ory keto - all left sidebar items in OEL section remain OEL except the 2 i mentioned above - almost there 🙏
  • ory polis - same as with hydra, intro and changelog remains in correct section, all other links switch you to OSS section 🚧
  • ory oathkeeper - same as ory hydra 🚧

@wassimoo
Merge remote-tracking branch 'origin/master' into fix/setup-guides-ac…
0a31cc3 
…ross-deployment-models

# Conflicts:
#	vercel.json
@vinckr vinckr merged commit 5474e3f into master Jun 23, 2026
12 checks passed
@vinckr vinckr deleted the fix/setup-guides-across-deployment-models branch June 23, 2026 16:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@unatasha8 unatasha8 unatasha8 left review comments

@vinckr vinckr vinckr approved these changes

@aeneasr aeneasr Awaiting requested review from aeneasr aeneasr is a code owner

@zepatrik zepatrik Awaiting requested review from zepatrik zepatrik is a code owner

@piotrmsc piotrmsc Awaiting requested review from piotrmsc piotrmsc is a code owner

Assignees

@wassimoo wassimoo

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@wassimoo @vinckr @unatasha8 @ory-bot